<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: faiss::NormalizationTransform Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Faiss
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacefaiss.html">faiss</a></li><li class="navelem"><a class="el" href="structfaiss_1_1NormalizationTransform.html">NormalizationTransform</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structfaiss_1_1NormalizationTransform-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">faiss::NormalizationTransform Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="VectorTransform_8h_source.html">VectorTransform.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for faiss::NormalizationTransform:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structfaiss_1_1NormalizationTransform.png" usemap="#faiss::NormalizationTransform_map" alt=""/>
  <map id="faiss::NormalizationTransform_map" name="faiss::NormalizationTransform_map">
<area href="structfaiss_1_1VectorTransform.html" alt="faiss::VectorTransform" shape="rect" coords="0,0,177,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a68da1a34995ec77c77cd892778e4740b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68da1a34995ec77c77cd892778e4740b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>NormalizationTransform</b> (int d, float norm=2.0)</td></tr>
<tr class="separator:a68da1a34995ec77c77cd892778e4740b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80c94dc7d17c9a7a9edc627150401571"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80c94dc7d17c9a7a9edc627150401571"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1NormalizationTransform.html#a80c94dc7d17c9a7a9edc627150401571">apply_noalloc</a> (idx_t n, const float *x, float *xt) const override</td></tr>
<tr class="memdesc:a80c94dc7d17c9a7a9edc627150401571"><td class="mdescLeft">&#160;</td><td class="mdescRight">same as apply, but result is pre-allocated <br/></td></tr>
<tr class="separator:a80c94dc7d17c9a7a9edc627150401571"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58cc73dea14c1591a8812291d3d85bc0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58cc73dea14c1591a8812291d3d85bc0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1NormalizationTransform.html#a58cc73dea14c1591a8812291d3d85bc0">reverse_transform</a> (idx_t n, const float *xt, float *x) const override</td></tr>
<tr class="memdesc:a58cc73dea14c1591a8812291d3d85bc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identity transform since norm is not revertible. <br/></td></tr>
<tr class="separator:a58cc73dea14c1591a8812291d3d85bc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structfaiss_1_1VectorTransform"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1VectorTransform')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structfaiss_1_1VectorTransform.html">faiss::VectorTransform</a></td></tr>
<tr class="memitem:a137f48bab695736f0b1d79a50cddc858 inherit pub_methods_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a137f48bab695736f0b1d79a50cddc858"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VectorTransform.html#a137f48bab695736f0b1d79a50cddc858">VectorTransform</a> (int d_in=0, int <a class="el" href="structfaiss_1_1VectorTransform.html#a589d612f7b1773614619a0cbecd728a9">d_out</a>=0)</td></tr>
<tr class="memdesc:a137f48bab695736f0b1d79a50cddc858 inherit pub_methods_structfaiss_1_1VectorTransform"><td class="mdescLeft">&#160;</td><td class="mdescRight">! output dimension <br/></td></tr>
<tr class="separator:a137f48bab695736f0b1d79a50cddc858 inherit pub_methods_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7350d4dd28d60866d55ba4f75d2da84c inherit pub_methods_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VectorTransform.html#a7350d4dd28d60866d55ba4f75d2da84c">train</a> (idx_t n, const float *x)</td></tr>
<tr class="separator:a7350d4dd28d60866d55ba4f75d2da84c inherit pub_methods_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3b3a8bf95911f4b28128001c83f91a5 inherit pub_methods_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top">float *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VectorTransform.html#af3b3a8bf95911f4b28128001c83f91a5">apply</a> (idx_t n, const float *x) const </td></tr>
<tr class="separator:af3b3a8bf95911f4b28128001c83f91a5 inherit pub_methods_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab79b9cb8dc4cf3a597cab563043568b9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab79b9cb8dc4cf3a597cab563043568b9"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><b>norm</b></td></tr>
<tr class="separator:ab79b9cb8dc4cf3a597cab563043568b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structfaiss_1_1VectorTransform"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1VectorTransform')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structfaiss_1_1VectorTransform.html">faiss::VectorTransform</a></td></tr>
<tr class="memitem:afdf56cbd261a571cf6b8872be5bd43b6 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdf56cbd261a571cf6b8872be5bd43b6"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>d_in</b></td></tr>
<tr class="separator:afdf56cbd261a571cf6b8872be5bd43b6 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a589d612f7b1773614619a0cbecd728a9 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a589d612f7b1773614619a0cbecd728a9"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VectorTransform.html#a589d612f7b1773614619a0cbecd728a9">d_out</a></td></tr>
<tr class="memdesc:a589d612f7b1773614619a0cbecd728a9 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="mdescLeft">&#160;</td><td class="mdescRight">! input dimension <br/></td></tr>
<tr class="separator:a589d612f7b1773614619a0cbecd728a9 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab511f1ddf608c00204555881ca28cb02 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VectorTransform.html#ab511f1ddf608c00204555881ca28cb02">is_trained</a></td></tr>
<tr class="separator:ab511f1ddf608c00204555881ca28cb02 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_structfaiss_1_1VectorTransform"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structfaiss_1_1VectorTransform')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structfaiss_1_1VectorTransform.html">faiss::VectorTransform</a></td></tr>
<tr class="memitem:a410516b4efdae041546d87f6bef2e422 inherit pub_types_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a410516b4efdae041546d87f6bef2e422"></a>
typedef <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>idx_t</b></td></tr>
<tr class="separator:a410516b4efdae041546d87f6bef2e422 inherit pub_types_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>per-vector normalization </p>

<p>Definition at line <a class="el" href="VectorTransform_8h_source.html#l00236">236</a> of file <a class="el" href="VectorTransform_8h_source.html">VectorTransform.h</a>.</p>
</div><hr/>The documentation for this struct was generated from the following files:<ul>
<li>/data/users/hoss/faiss/<a class="el" href="VectorTransform_8h_source.html">VectorTransform.h</a></li>
<li>/data/users/hoss/faiss/<a class="el" href="VectorTransform_8cpp_source.html">VectorTransform.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
